home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / MONITOR / GAM11.ARJ / GAM.DOC < prev    next >
Text File  |  1992-07-01  |  20KB  |  474 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                       The Great American Ansi Machine
  13.                                 Version 1.0
  14.  
  15.  
  16.                          - Program Documemtation -
  17.  
  18.  
  19.                        (C) Copyright 1992 Rand Nowell
  20.                        ──────────────────────────────
  21.                              RaLin Enterprises
  22.                         "Putting Bits Together" (tm)
  23.  
  24.  
  25.  
  26.                              Released July 1992
  27.  
  28.  
  29.  
  30.  
  31.  
  32.    Copyright:
  33.  
  34.    The Great American Ansi Machine, the program and documentation,
  35.    is not a Public Domain or Free program. It is the
  36.    Copyrighted (C)1992 work of Rand Nowell dba Ralin Enterprises.
  37.    All rights are reserved. Copying, duplicating, selling or otherwise
  38.    distributing this product except as noted in the Distribution Policy
  39.    below is a violation of Federal Copyright Law.
  40.  
  41.    You are authorized to evaluate the program for a period of two weeks.
  42.    If after two weeks you wish to continue using the program, registration
  43.    is in order. Please see REGISTER.DOC
  44.  
  45.    Distribution:
  46.  
  47.    1. Feel free to distribute the Shareware version of this program as
  48.       often as you like to any interested parties. Distribution to
  49.       Electronic Bullentin Boards is encouraged.
  50.    2. Please do not distribute this program without all the original
  51.       related files such as documentation, readme files, registration
  52.       forms etc.
  53.    3. Please distribute ONLY the original authenticated ZIP format file.
  54.    4. Please obtain our written permission before including the program
  55.       with any "bundled" software packages.
  56.    5. Please do not accept payment for the program; a copying fee of
  57.       $5.00 per diskette may be charged by a non-profit user-group.
  58.    6. Please do not alter the program or documentation in any way.
  59.    7. Individuals, groups, vendors or other software distribution
  60.       companies which market diskettes containg shareware or test-drive
  61.       evaluation programs, for profit, must obtain written permission
  62.       from RaLin Enterprises prior to distribution.
  63.  
  64.     DISTRIBUTION of the REGISTERED version of this program is in
  65.     violation of the license agreement and copyright law.
  66.  
  67.     ************************* DISCLAIMER *****************************
  68.  
  69.     This program is supplied "as is" without warrenty of any kind. The
  70.     entire risk of using, and results from the use of, is assumed by you
  71.     the user.  You assume all costs of repair, servicing and corrections
  72.     stemming from the use of this program.
  73.     Rand Nowell and/or RaLin Enterprises, or any other associated
  74.     company of the program author will not be held liable for any
  75.     damages from the use of this program. No warranties are expressed or
  76.     implied.
  77.     ********************************************************************
  78.     To the original licensee of the REGISTERD version of The Program
  79.     RaLin Enterprises DOES warrant that the program disk(s) on which the
  80.     program is recorded, be free from defects in material and
  81.     workmanship under normal use and service for a period of (90) ninety
  82.     days from date of delivery as evidenced by your receipt. Our entire
  83.     liability and your exclusive remedy shall be replacement of the
  84.     deffective disk not meeting the standards of this limited warranty.
  85.     And in no case shall exceed the cost of reimbursment of monies paid for
  86.     program registration.
  87.  
  88.   
  89. GAM.DOC             The Great American Ansi Machine Ver 1.0        Page   1
  90.  
  91.  SYSTEM REQUIREMENTS:
  92.  
  93.         Dos Ver:        Dos 3.x and above. Should work with DR Dos and
  94.                         4Dos, but not tested.
  95.  
  96.         Memory:         Requires 300K available memory if you intend to
  97.                         run external programs. This is a comfortable margin,
  98.                         you can get by with a little less.
  99.                         GAM itself will run in as little as 100K. It uses
  100.                         aprox. 60K for its own use, so 100K would be pretty
  101.                         slim!
  102.  
  103.          Video:         Requires a Color Monitor, CGA,EGA,VGA
  104.  
  105.        Drivers:         Requires that Ansi.Sys or a similar video driver
  106.                         be loaded on memory, to enable Ansi displays.
  107.  
  108.     Hard Drive:         Recommended, but GAM will run from a 360K floppy.
  109.  
  110.          Other:         None, except the urge to have fun with Ansi's.
  111.  
  112.  
  113.  INTRODUCTION:
  114.  
  115.  GAM.EXE is The Great American Ansi Machine. Now just what is a Ansi
  116.  Machine? Well, this one is a Menu Driven Shell type program.
  117.  Once you start GAM you can create ANSI files, create Asci/Ansi letter
  118.  files and view your creations, or those of others....All From One Program!
  119.  GAM will take some of the work out of your viewing time, and insert a
  120.  little more pleasure.
  121.  
  122.  Not only does GAM present you with a Shell for your Ansi creation and
  123.  viewing, it works as a command line viewer too. Now, you're probably saying
  124.         "Why should I use GAM? I can just use the DOS Type command!"
  125.  Well thats true. But there are benefits to using GAM, even without the Menu
  126.  Driven Interface! And that will be explained further, a little ways down
  127.  the document.
  128.  
  129.  The Great American Ansi Machine was created to simplify the command typing
  130.  thats involved in loading the drawing program, and viewing the files.
  131.  A couple of keypresses and you can change directories, select a file and
  132.  Viola! there it is...displaying on your screen.
  133.  
  134.  OK...Now lets get down to business!
  135.  
  136.  WHERE TO PUT FILES:
  137.  
  138.  The files GAM.EXE, TDRAW.BAT and LETTERS.BAT should be placed in a
  139.  directory that is included in the PATH statement, which should be a part of
  140.  your AUTOEXEC.BAT startup file. This will allow them to be called from
  141.  anywhere in the system.
  142.  
  143.  
  144.  
  145.   Program Documentation -  July 1, 1992 
  146.  
  147.  
  148. GAM.DOC             The Great American Ansi Machine Ver 1.0        Page  2
  149.  
  150.  COMMAND LINE USE:
  151.  
  152.  GAM can be used from the command prompt, without going through the Menu
  153.  interface. For a brief Help Screen you can type GAM ?, this presents a
  154.  simple listing of command line use.
  155.  
  156.   To view an Ansi file you type GAM <filename> where filename is the name of
  157.   the Ansi File "without the extension", most people use the default file
  158.   extension of .ANS for Ansi files, if your files conform to this standard
  159.   then the extension is not needed. GAM will append the extension to the
  160.   filename.
  161.  
  162.   Thus, if you wanted to view the file MYHOUSE.ANS you would simply type
  163.   GAM MYHOUSE and press <Enter>. Now and then you, or others, will have a
  164.   reason to save the Ansi file with a different extension, if this is the
  165.   case then you need to include it in the filename, so to display an Ansi
  166.   file named MYHOUSE.MSG you would type GAM MYHOUSE.MSG.
  167.  
  168.   GAM will then display the Ansi to the screen. Once the Ansi has been
  169.   typed, after a 2-3 second pause, a message bar will display across the
  170.   bottom of the screen. Then message bar contains the name of the file you
  171.   are viewing and tells you to press the Space Bar to exit. Doing so will
  172.   clear the screen and return you to the prompt. Most times, this message
  173.   will not interfere with the picture, but occasionally you will have a
  174.   screen that uses all 25 lines. This is why there is a pause before the
  175.   bar displays, so you can see the whole picture.
  176.  
  177.  RUNNING THE PROGRAM:
  178.  
  179.   Type GAM with no parameters at the Dos prompt. This will load the Menu
  180.   Driven Interface. You will be presented a colorful main screen containing
  181.   a horizontal Menu Bar across the top.
  182.  
  183.  THE MAIN MENU:
  184.   ────────────────────────────────────────────────────────────────────────
  185.   Files      Draw     Help     Info      Quit
  186.   ────────────────────────────────────────────────────────────────────────
  187.    These menu choices will be covered one by one in the following text.
  188.    Each one will be fully explained, covering all actions that are available
  189.    from each, in detail.
  190.  
  191.    The Menu highlite bar may be moved from choice to choice by pressing the
  192.    left and right arrow keys. Pressing the spacebar will also move the
  193.    selector one choice to the right with each press. When the selector
  194.    reaches the far left or right choice it will wrap to the other end of the
  195.    Menu Bar. When the choice you want is highlighted you can activate it by
  196.    press Enter, or either the Up or Down arrow key. You may also choose and
  197.    Activate a menu choice by pressing the Highlighted Character of an item.
  198.  
  199.    The "Files" and "Draw" choice each present another menu, where your
  200.    selections can be made by selecting and pressing Enter, or pressing the
  201.    highlighted character. To ABORT a Sub-Menu just press Esc. This will out
  202.    the Sub-Menu away and return to the Main Menu.
  203.  
  204.   Program Documentation -  July 1, 1992 
  205.  
  206.  
  207. GAM.DOC             The Great American Ansi Machine Ver 1.0        Page  3
  208.  
  209.  
  210.  BOTTOM LINE HELP:
  211.  
  212.    You will notice while moving the selector bar across the Menu Bar
  213.    choices, a brief description of that choices actions is displayed at the
  214.    bottom of the screen.
  215.  
  216.  THE MENU CHOICES:
  217.  
  218.      FILES:   Choosing Files will present a Sub-Menu where you may choose
  219.      Pick List or Dos Shell.
  220.  
  221.     >>  Dos Shell: Selecting this will take you to the Dos Command Prompt,
  222.        where you may execute any Dos command, or run another program.
  223.        Typing EXIT will return you to The Machine. GAM uses about 60K of
  224.        memory, so you get whats left.  Please remember...........
  225.        1. DO NOT LOAD TSR PROGRAMS WHILE IN THE DOS SHELL
  226.        2. DO NOT RELOAD GAM...YOU WILL GET THOROUGHLY CONFUSED.
  227.  
  228.     >> Pick List:  The screen will clear and you will see a File Display
  229.        window, and to the left a menu of Command Function Keys. The files
  230.        that come up in the window are those in the directory where you first
  231.        start GAM. At the top of the list will be displayed the current
  232.        directory. At the bottom of the list will be displayed MORE if there
  233.        are more files to view, and NO MORE FILES if there are not.
  234.        (Makes sense....) Now, in order to conserve somewhat on memory usage
  235.        and manipulation, GAM uses a direct read and write to display the
  236.        files. So you cannot just move a cursor bar up and down and scroll
  237.        the display. Actually I belive this way is somewhat faster when you
  238.        have to search through a large number of files.
  239.        Here are the Function Keys and what they do.
  240.  
  241.      F1: Menu Bar
  242.          When the file you want to view is displayed in the
  243.          window, press F1 to activate the selector bar. Place the bar on a
  244.          filename and press Enter. If the name selected is a file, it will
  245.          be displayed on the screen. If the name is a directory then GAM
  246.          will change to that directory and display those files.
  247.      NOTE: Currently GAM does not check for a valid file format. So it is
  248.          possible to select and display any file....BAT, .TXT and even COM
  249.          and EXE files. If you display a COM or EXE file, or any file that
  250.          is not of a text file nature, you will just see garbage and hear a
  251.          lot of beeps. What a mess! Valid file checking is slated for a
  252.          future release, in the meantime, be sure of your selection. And if
  253.          you DO try to display an invalid file, let it do its thing...soon
  254.          you will be able to return to the Pick List. If its a large file,
  255.          and you don't want to wait, you can press Ctrl-C...this will abort
  256.          and EXIT the program.
  257.  
  258.   Once a file has been selected to view, GAM will display the file to your
  259.   screen. Once the file has been drawn, there will be about a 2-3 second
  260.   pause, then a message bar will display on the last line, showing the file
  261.   name and telling you to press the Space Bar to exit.
  262.  
  263.   Program Documentation -  July 1, 1992 
  264.  
  265.  
  266. GAM.DOC             The Great American Ansi Machine Ver 1.0        Page  4
  267.  
  268.  
  269.   ABORTING THE PICKLIST:
  270.   NOTE: ONCE THE MENU BAR HAS BEEN ACTIVATED, THE FUNCTION KEYS WILL NO
  271.         LONGER WORK. TO ABORT THE PICK LIST PRESS ESC. ALSO SEE F6 BELOW.
  272.  
  273.      F2: Show More
  274.          This key will display the next 19 files to be found in the current
  275.          directory. You can use this to browse through all files in the
  276.          directory. If you happen to pass up the file you want, or just want
  277.          to view those already passed, just press.....
  278.  
  279.      F3: Re-Display - This will re-display files from the beginning.
  280.  
  281.      F4: Change Drive
  282.          This key will allow you to log onto another drive. This can be
  283.          another fixed disk or a floppy. A window will pop up asking what
  284.          drive...press the letter of the drive you wish to change to.
  285.  
  286.    ACCESSING FLOPPY FILES:
  287.  
  288.    Should you log onto a floppy drive without a disk inserted, or the door
  289.    open, GAM will attempt to log for several seconds. You have this time to
  290.    correct the problem by closing the door, or inserting the disk. If you do
  291.    not do this soon enough, you will hear a beep and a message will show
  292.    stating NO FLOPPY, you will then be returned to the Main Menu.
  293.  
  294.      F5: CD..
  295.          This key will immediately log the parent directory of the one you are
  296.          currently in. This is usefull for backing up through directories.
  297.  
  298.      F6: Quit List
  299.          This will exit the Pick List and return you to the Main Menu.
  300.          REMEMBER: These function keys are NOT available once the Menu Bar
  301.          has been activated, you will have to press Esc to abort.
  302.  
  303.   DRAW:
  304.         This presents two Menu choices, (Ansi) and (Fonts). They have been
  305.         provided as a means to call your favorite drawing programs from
  306.         within GAM. Two batch files are required. To call your drawing
  307.         program edit the supplied file TDRAW.BAT and insert the proper
  308.         commands. To call your letter/font generating program edit the
  309.         LETTERS.BAT file and insert the proper commands.
  310.  
  311.         NOTE: THESE BATCH FILES SHOULD BE PLACED IN A DIRECTORY THAT IS IN
  312.         YOUR PATH STATEMENT.
  313.  
  314.   HELP: This will present two Help screens with some command basics and
  315.         helpful information.
  316.  
  317.   INFO: Displays a screen showing the Current Time and Date, and some
  318.         program information.
  319.  
  320.   QUIT: Exits the Great American Ansi Machine. When GAM starts up, it saves
  321.  
  322.   Program Documentation -  July 1, 1992 
  323.  
  324.  
  325. GAM.DOC             The Great American Ansi Machine Ver 1.0        Page  5
  326.  
  327.         a record of which directory it was called from. Upon Exit it will
  328.         take you back to that directory. This is protection for exiting
  329.         while still logged onto a floppy, and perhaps the disk has been
  330.         removed. Were that to happen you would receive the "Drive Not Ready"
  331.         Dos message. So no matter where you go in GAM, you will end up where
  332.         you started.
  333.  
  334.  
  335.   AUTHOR COMMENTS:
  336.  
  337.   It is hoped that you find The Machine a useful and enjoyable tool, and
  338.   thats just what it is... A Tool. (But a fun one!) This program is being
  339.   distributed under the Shareware Concept, an explanation follows.
  340.  
  341.   WHAT IS SHAREWARE?:
  342.  
  343.    A Shareware Program is one that the Author distributes out into Public
  344.    Access, so that you may try it out for evaluation. This gives you the
  345.    opportunity to check it out and see if it fits your needs without putting
  346.    out your hard earned cash up front. If you find the program useful, it is
  347.    expected that you will pay the Registration fee requested. If you find
  348.    the program not what you need...delete it from your disk. Its only the
  349.    right thing to do!  We authors spend countless hours developing useful
  350.    programs that you may purchase at a very reasonable price. And we depend
  351.    on your honesty to register if you intend to continue the programs use.
  352.  
  353.    PROGRAM LICENSE:
  354.  
  355.    You are authorized to use this program free of charge for a period of two
  356.    weeks. If after that period, you continue its use, a registration is in
  357.    order. If you do not intend to register the program, please delete it
  358.    from your drive. HONESTY PAYS!
  359.  
  360.    NO CRIPPLING:
  361.  
  362.    This program is not crippled in any way. It is a fully functional copy,
  363.    and differs from the Registered version only in that some reminders, if
  364.    included here, will not be shown in the Registered version. Also, if a
  365.    newer version has been hatched at the time of your Registration, you will
  366.    receive that newer version.
  367.  
  368.    REGISTRATION INCENTIVES:
  369.  
  370.    Upon receiving a registration form and the registration fee, you will
  371.    receive:
  372.    1. A copy of the program, without reminder(s).
  373.    2. Several Utility packages developed by the Author including but not
  374.       limited to, several handy Screen Savers, some Print and View
  375.       utilities.
  376.    3. A listing of some of our other programs available, and where to get
  377.       them.
  378.    4. Notification of new releases.
  379.    5. Complete support for the product, mail,phone or Elec.Mail.
  380.  
  381.   Program Documentation -  July 1, 1992 
  382.  
  383.  
  384. GAM.DOC             The Great American Ansi Machine Ver 1.0        Page  6
  385.  
  386.  
  387.    REGISTRATION:
  388.  
  389.    1. $15.00 (One time registration) all the above, plus you are registered
  390.       for all future releases. (YES there will be more.)
  391.  
  392.    2. $10.00 (One time Registration) you receive support as above, but no
  393.       extra utilities. Belive me...the utilities are worth more than five
  394.       bucks!
  395.  
  396.    3. $.? Money tight? Yep, I know the feeling!  If you enjoy the program
  397.       but cannot afford to register right now, please send what you can, as
  398.       a gift in exchange for the copy you have.
  399.  
  400.    YOUR COMMENTS:
  401.  
  402.    User comments, good or bad are always welcome! If you have an idea or a
  403.    request for enhancement of the program. Let me know! I most always
  404.    implement GOOD suggestions into my programs. The EXTRA good ideas get
  405.    rewarded too!
  406.    Comments and suggestions can be sent in on the Comments Form, attached to
  407.    the Registration Form.
  408.  
  409.  
  410.  AUTHOR CONTACT:
  411.  
  412.  
  413.           I can be reached by several means.
  414.  
  415.         Phone: (510) 651-0253 Ask for Rand
  416.           If you get my wife, or the answering machine, please leave your
  417.           name, number, and a brief description of the problem, and I will
  418.           get back to you ASAP! (See SUPPORT below)
  419.  
  420.         Net Mail:        1:215/777  or 1:161/42  Rand Nowell
  421.         Compuserve ID:   76124,761 (Checked 1-2 times a month)
  422.         FIDO Net:        Shareware Conference   Rand Nowell
  423.         Mail:            Rand Nowell
  424.                          RaLin Enterprises
  425.                          49728 Sundale Dr.
  426.                          Fremont, Ca. 94538
  427.  
  428.  
  429.    SUPPORT:
  430.          Registered users receive full unlimited support, if I have to call
  431.          you back, it will be on my dime!
  432.          Unregistered users will receive help, but if I have to call, expect
  433.          a collect one.
  434.  
  435.    See the REGISTER.DOC file for our Registration plans.
  436.  
  437.    If you have any comments (good or bad) or suggestions, please use the
  438.    Comments/Suggestions form attached to the Registration.
  439.  
  440.   Program Documentation -  July 1, 1992 
  441.  
  442.  
  443. GAM.DOC             The Great American Ansi Machine Ver 1.0        Page  7
  444.  
  445.  
  446.    Thank You!
  447.  
  448.  
  449.  
  450. ACKNOWLEDGEMENTS:
  451.  
  452.    The Great American Ansi Machine was written with Turbo Pascal
  453.    version 6.0, a product of Borland International.
  454.    A GREAT programming language!
  455.    Thanks Borland, for a job well done.
  456.  
  457.  
  458.    All screens in The Machine were created with the Saywhat! screen
  459.    generator, a product of Software Science. Saywhat is hands down the
  460.    best utility to create and manipulate screens from within  MANY
  461.    programming languages.
  462.    My appreciation to Software Science.
  463.  
  464.  
  465.    To those of you who Register, Thanks for helping support the
  466.    SHAREWARE CONCEPT! Registering this and other products, give the
  467.    authors incentive to continue enhancements and to develop new products
  468.    for your use.
  469.  
  470.  
  471.  <eof> GAM.DOC........
  472.    Program Documentation -  July 1, 1992 
  473.  
  474.